Pixel-perfect Reports Widget
The Pixel-perfect Reports widget enables you to embed the Pixel-perfect Reports feature in an application.
Configuration Object Properties
The following table lists the properties associated with this widget.
| Property | Value | Required |
|---|---|---|
| api_key | String, Your organization’s unique API key required to access the Qrvey platform. Never expose your organization’s API key to external users. In Production environments, use a secure token (qv_token) to encrypt the API key. | Yes, if the qv_token is not provided |
| app_id | String, ID of the Qrvey application containing the webform. | Yes |
| user_id | String, ID of the Qrvey Composer user account accessing this feature. Optional: You can alternately specify the user ID in a Qrvey session cookie. | Yes |
| clientId | String, Unique identifier for the tenant end user. Required for using the Download Manager feature. The clientId must be set to a unique value for each tenant end user. | No |
| domain | String, The base URL of your instance of the Qrvey platform. | Yes |
| qv_token | A more secure way to authenticate and authorize embedded widgets is through a Security Token requested as a backend-to-backend communication between your backend side of the host application and the Qrvey system. | Yes, if no api_key is provided |
| timezone | Object <TimezoneConfiguration>, Overrides the time zone setting in Qrvey Admin Center. For more information, see Configuring Time Zone Settings. | No |
| report_id | String, used to embed a specific report. | No |
| show_embed_button | Boolean, shows or hides the embed button. By default the embed button is hidden in embedded scenarios. | No |
| show_formulas_button | Boolean, shows or hides the formula modal button in the toolbar. It is visible by default. | No |
| parameter_values | Object. {key1: value, key2: value}, you can set the value of a parameter from the configuration object. This value will override the default value set for the parameter. | No |
| default_mode | String, either "preview" or "design". A value of "preview" enables users to embed the Pixel-perfect Reports in preview mode. Defaults to "design" if not set. | No |